OSA Документация

Редактирование структурированного документа ​

Для редактирования структурированного документа, находясь в реестре или карточке структурированного документа, нажмите на кнопку "Отредактировать документ". Структурированный документ будет открыт в Режиме редактирования в Редакторе структурированного документа

Редактор структурированного документа ​

Интерфейс ​

Ниже представлен интерфейс Редактора структурированных документов

Интерфейс Редактора структурированных документов включает следующие элементы:

  1. Панель инструментов - предназначена для размещения элементов управления Редактора структурированных документов
  2. Рабочее пространство редактора - предназначено для размещения виджетов, использующихся для редактирования структурированных документов

Панель инструментов ​

С помощью Панели инструментов можно вызвать следующие функции:

  • Кнопка "Автосохранение". Позволяет отключать и включать режим автоматического сохранения структурированного документа. По умолчанию, режим автоматического сохранения включен

  • Кнопка "Сохранить документ". Позволяет принудительно сохранить структурированный документ (Ctrl-S)

  • Кнопка "Показать диалог вставки". Позволяет вызвать диалоговое окно вставки кросс-ссылок на содержимое документа (см. раздел Добавление ссылок на содержимое документа)

  • Кнопка "Загрузить файл". Позволяет прикреплять файлы к структурированному документу (см. раздел Загрузка файлов в документ)

  • Кнопка "Список загруженных файлов". Позволяет просмотреть и отредактировать список прикрепленных файлов (см. раздел Список загруженных файлов)

  • Кнопка "Настройки". Позволяет установить настройки структурированного документа (см. раздел Настройка редактора)

  • Кнопка "Разметить документ терминами". Позволяет выполнить автоматическую разметку структурированного документа терминами (см. раздел Разметка документа терминами)

  • Кнопка "Извлечь термины". Позволяет выполнить автоматическое извлечение терминов из структурированного документа (см. раздел Извлечение терминов)

  • Кнопка "Включить комментарии". Позволяет включить режим работы с комментариями в виджете Предварительный просмотр (см. раздел Работа с комментариями)

  • Кнопка "Добавить виджеты". Позволяет размещать виджеты на Сервисной панели (см. раздел Виджеты)

  • Кнопка "Шаблоны окон документа". Позволяет использовать шаблоны конфигурации Сервисной панели (см. раздел Настройка рабочей области редактора)

  • Кнопка "Открыть в режиме просмотра". Позволяет открыть структурированный документ в режиме просмотра (см. раздел Режим просмотра)

  • Кнопка "Руководства пользователей". Позволяет открыть список горячих клавиш и справку по разделу

  • Кнопка "Задать вопрос". Открывает чат с ИИ-ассистентом (см. раздел ИИ-ассистент)

Настройка редактора ​

Установки, описанные в данном разделе, относятся к отображению содержимого виджетов Редактор и Предварительный просмотр, и не влияют на итоговый документ.

Для настройки редактора:

  1. Нажмите на кнопку "Настройки" на Панели инструментов редактора
  2. Выполните настройку редактора путем установки следующих параметров:
    1. Параметры отображения компонентов: позволяют изменить представление компонентов в виджете Редактор:
      • Свернуть компоненты - при установке все компоненты будут свернуты
      • Контуры компонентов - включает отображение контуров компонентов
      • Отступы компонентов - минимизирует отступы вложенных компонентов
      • Названия компонентов - при установке, наименования компонентов будут скрыты. Также будут скрыты некоторые элементы управления на Панели инструментов компонентов
      • Подсвечивать активные компоненты в просмотре - компоненты, выделенные в виджете Редактор, будут помечены вертикальной линией в виджете Предварительный просмотр
      • Отключить компоновщики - содержимое компоновщиков будет выведено в виджете Предварительный просмотр в раскрытом состоянии
    2. Свойства документа: позволяют установить свойства компонентов для всего документа:
      1. Закладка Параметры:
        • Выравнивание текста - устанавливает порядок выравнивания текста во всех компонентах с текстовым содержимым по умолчанию. При этом, для каждого компонента выравнивание может быть переопределено в свойствах компонента
        • Сквозная нумерация библиографий - устанавливает сквозную нумерацию библиографических ссылок в документе. Рекомендуется при использовании библиографических ссылок, добавленных как внешнее содержимое из другого документа
        • Запоминать последние установленные настройки - при создании новых компонентов, последние установленные настройки будут автоматически применять к ним
      2. Закладка Нумерация:
        • настройка нумерации компонентов для всего документа выполняется аналогично с настройкой нумерации для компонентов, поддерживающих нумерацию, описанной в разделе Настройка нумерации компонентов
    3. Разделение компонентов - по умолчанию, для разделения компонентов используется комбинация клавиш Shift + Enter. Данная настройка позволяет переопределить разделение компонентов по клавише Enter
    4. Кнопка Сохранить фактическую нумерацию предназначена для сохранения текущей нумерации компонентов в базе данных (см. раздел Сохранение фактической нумерации документа)
    5. Включить все отключенные компоненты - позволяет включить все отключенные компоненты в виджете Редактор для отображения в виджете Предварительный просмотр

Настройка рабочей области редактора ​

Настройка рабочей области редактора заключается в расположении виджетов в рабочей области редактора. Это можно сделать с помощью преднастроенных шаблонов или вручную.

Для настройки рабочей области редактора с помощью шаблонов:

  1. Нажмите на кнопку "Шаблоны окон документа" на Панели инструментов Редактора
  2. Выберите соответствующий вашим предпочтениям шаблон

Кастомизированные настройки рабочей области редактора можно выполнить путем добавления или удаления виджетов (см. раздел Виджеты)

Информация

Настроенная рабочая область Редактора сохраняется в процессе сохранения документа.

Загрузка файлов в документ ​

Для загрузки приложенных файлов к документу:

  1. Нажмите на кнопку "Загрузить файл" на Панели инструментов редактора документов

Будет открыто окно Проводника операционной системы

  1. В окне Проводника выберите соответствующий файл и нажмите на кнопку Открыть

Файл будет загружен в документ для последующего использования, а ссылка на него будет скопирована в буфер обмена для вставки в содержимое документа (использовать при необходимости)

Список загруженных файлов ​

Для просмотра загруженных в документ файлов:

  1. Нажмите на кнопку "Список загруженных файлов" на Панели инструментов редактора документов
  2. Для добавления файлов в документ кликните по полю Выберите файл
  3. Для вставки ссылки на файл в документ нажмите на кнопку "Ссылка" для копирования ссылки
  4. Для удаления файла из документа нажмите на кнопку "Удалить"
  5. Для загрузки файла на компьютер кликните по наименованию файла

Работа с комментариями ​

В структурированных документах возможность комментирования доступна в режимах Редактирования и Просмотра. В данном разделе описан порядок работы с комментариями в режиме Редактирования в виджете Предварительный просмотр.

Внимание

Возможность комментирования документа доступна только пользователям, имеющим назначения на роли в данном документе.

Порядок работы с комментариями:

  • просмотр комментариев доступен всем участникам обсуждения
  • редактировать комментарии может только автор
  • только автор комментария может закрыть обсуждение
Добавление комментариев ​

Для добавления комментариев:

  1. Добавьте виджет Предварительный просмотр на сервисную панель.
  2. Включите режим работы с комментариями используя кнопку "Включить комментарии" на Панели инструментов Редактора документов
  3. Выделите соответствующее содержимое в виджете Предварительный просмотр

Справа от выделенного содержимого будет выведена форма комментария

  1. Введите комментарий и нажмите на кнопку "Добавить"

Информация

После добавления комментарий сохраняется автоматически, независимо от сохранения документа.

Редактирование комментариев ​

Для редактирования комментариев:

  1. Наведите курсор на соответствующий комментарий, нажмите на кнопку "Другие действия" в форме комментария и выберите пункт "Изменить"
  2. Выполните редактирование комментария и нажмите на кнопку "Обновить"

Результат редактирования комментария будет сохранен автоматически

Ответ на комментарий ​

Для ответа на комментарий:

  1. Кликните мышкой по форме комментария

В форме комментария будет выведено поле для ответа

  1. Введите ответ и нажмите на кнопку "Добавить"
Навигация по комментариям ​

Для навигации по комментариям используйте кнопки, выведенные в верхней правой части виджета Предварительный просмотр:

  • "Вниз" - для перемещения к следующему комментарию
  • "Вверх" - для перемещения к предыдущему комментарию
Завершение обсуждения ​

Для завершения обсуждения:

  1. Наведите курсор на соответствующий комментарий
  2. Нажмите на кнопку "Отметить обсуждение как завершенное"

Обсуждение будет отмечено как завершенное

Для возобновления обсуждения:

  1. Наведите курсор на соответствующий комментарий
  2. Нажмите на кнопку "Снять отметку о завершении"
Удаление комментариев ​

Для удаления комментариев:

  1. Наведите курсор на соответствующий комментарий
  2. Нажмите на кнопку "Другие действия" в форме комментария и выберите пункт "Удалить"

Внимание

Комментарий удаляется без подтверждения и безвозвратно!

Сохранение фактической нумерации документа ​

В виду того, что нумерация документа в режиме редактирования рассчитывается динамически, она не сохраняется в документе, как отдельная сущность. В некоторых случаях, например при исследовании в факт-эксплорере или анализе компонентов документа, как объектов (экземпляров класса) платформы OSA, бывает необходимо использовать нумерацию. Функция сохранения фактической нумерации документа выполняет сохранение текущей нумерации компонентов документа в свойстве Сохраненный номер пункта. Сохраняется нумерация только тех элементов, у которых она фактически имеется, у остальных проставляется пустое значение.

Для сохранения фактической нумерации документа:

  1. Нажмите на кнопку "Настройки" на Панели инструментов Редактора документа
  2. В открывшейся форме нажмите на кнопку Сохранить фактическую нумерацию

Для просмотра значения сохраненной нумерации компонента в факт-эксплорере:

  1. Нажмите на кнопку "Действия" на Панели инструментов компонента
  2. Выберите пункт Открыть в факт-эксплорере
  3. В открывшемся факт-эксплорере:
    • выделите соответствующий компонент (экземпляр)
    • в появившемся меню выберите пункт Карточка экземпляра

В открывшейся карточке экземпляра, в поле Сохраненный номер пункта, будет выведено соответствующее значение

Внимание

Необходимо следить и вовремя актуализировать нумерацию компонентов документа, сохраненную с помощью данной функции!

Информация

Данная функция поддерживается компонентами, для которых доступна нумерация.

Совместная работа над документом ​

Редактор структурированных документов поддерживает групповое редактирование документов, т.е., команда разработчиков может независимо друг от друга выполнять разработку одного документа. Изменения, внесенные в документ, будут отображаться для всех пользователей по мере сохранения изменений каждым пользователем. Режим группового редактирования документа включается автоматически при редактировании документа более чем одним пользователем.

Назначение на роли ​

Для выполнения группового редактирования документа необходимо выполнить назначение на роли. Назначение на роли можно выполнить как для существующего документа (имеющего содержимое), так и для вновь созданного.

Выполните назначения на роли для всех участников группы разработки документа. Назначения может выполнить автор документа или пользователь, наделенный соответствующими правами:

  1. Откройте карточку структурированного документа в реестре Структурированные документы
  2. Перейдите на закладку Назначения
  3. Нажмите на кнопку Добавить

    1. В поле "Роль" установите роль пользователя, для которого выполняется назначение:

    2. Выберите пользователя или группу пользователей для назначения на роль:

      • Поле "Пользователь" предназначено для выбора одного или нескольких пользователей для назначения на роль
      • Поле "Группа пользователей" предназначено для назначения на роль заранее определенной группы пользователей

    3. При необходимости, установите период действия назначения в поле "Активно до"

    4. Для сохранения нового назначения нажмите на кнопку Сохранить

Все пользователи, для которых были выполнены назначения на роли, получат соответствующие права на работу с документом.

Доступно множественное назначение на роли: пользователя или группу пользователей одним назначением можно назначить на роль "Редактор", а другим - на роль "Редактор структуры документа".

  1. Для редактирования назначений нажмите на кнопку "Редактировать" в строке с соответствующим назначением

  2. Для удаления назначений нажмите на кнопку "Удалить" в строке с соответствующим назначением

  3. Проинформируйте участников группы разработки о выполненном назначении

Групповое редактирование документа ​

Для выполнения редактирования документа, пользователь должен иметь назначение на роль Редактор.

Для выполнения группового редактирования документа:

  1. Откройте документ в режиме редактирования:

    1. Если документ находится в режиме группового редактирования:

      • будет выведено соответствующее уведомление о пользователях, которые в данный момент редактируют документ
      • кнопки ручного и автоматического сохранения на Панели инструментов редактора будут заменены кнопкой "Включен совместный режим", при наведении курсора на которую будет выведен список пользователей, редактирующих документ
      • документ будет автоматически переведен в режим автоматического сохранения изменений

      Внимание

      Групповое редактирование документа выполняется в режиме монопольного доступа к компонентам, т.е., если один пользователь редактирует компонент, то данный компонент блокируется и будет недоступен для редактирования другими пользователями. При этом, заблокированный компонент будет соответствующим образом выделяться в виджете Редактор.

      На рисунке ниже приведен пример индикации заблокированного компонента:

      В верхней правой части заблокированного компонента будет отображаться ФИО пользователя, редактирующего компонент

  2. Выполните редактирование документа

Все изменения, внесенные в документ в режиме группового редактирования, сохраняются автоматически: в момент переключения с одного компонента на другой, будет выполняться автоматическое сохранение изменений в текущем компоненте, если оно было внесено

  1. Для ручного сохранения результата редактирования компонента и документа в целом, нажмите на кнопку "Включен совместный режим"

Изменения, внесенные в компонент, будет сохранены и отобразятся для всех участников группы разработки документа.

Редактирование структуры документа ​

Для выполнения редактирования структуры разделов документа, пользователь должен иметь назначение на роль Редактор структуры документа.

Информация

Редактор структуры документа может изменять только структуру разделов документа. Изменение наименований разделов будут недоступны.

Редактирование структуры разделов документа в режиме группового редактирования выполняется по аналогии с редактированием документа одним пользователем. При этом, блокировка разделов будет применяться от текущего раздела ко всем вложенным разделам и компонентам. Блокировка будет кратковременной и не вызовет затруднений в работе у других участников команды, работающих с документом.

Основные способы редактирования структуры разделов документа описаны в разделах:

Работа с терминами ​

Для работы с терминологической базой в структурированных документах существует несколько функций, которые позволяют выполнять работу с терминами как в автоматическом, так и в ручном режимах. К автоматическим функциям относятся:

Для ручной разметки документа терминами используется функция ручной разметки терминами, которая может быть использована как для разметки терминами в процессе написания документа, так и для финальной разметки документа терминами в процессе верификации терминологической работы с документом.

Совет

Для первичного наполнения терминологической базы используйте автоматическую функцию Извлечение терминов.

Для дальнейшей работы рекомендуется следующая последовательность применения функций:

  1. Разметка документа терминами - для первичной разметки документа существующими терминами
  2. Извлечение терминов - для извлечения терминов, отсутствующих в терминологической базе
  3. Ручная разметка терминами - для уточнения и финализации терминологической работы с документом

Разметка документа терминами ​

Данная функция предназначена для автоматического определения терминов в документе по данным терминологической базы и установки соответствующей терминам маркировки. Выявление терминов выполняется независимо от использованной словоформы. В роли терминологической базы может выступать отдельный класс или таксономия классов, содержащие термины, для которых введены определения в дискурсах объектов.

Для разметки документа терминами:

  1. Нажмите на кнопку "Разметить документ терминами" на Панели инструментов Редактора

  2. В появившемся окне внимательно прочитайте предупреждения и нажмите на кнопку ОК

  3. В окне Параметры разметки терминами:

    • в поле Классы-ограничения на поиск терминов выберите классы для ограничения поиска терминов в терминологической базе
    • при необходимости, измените установленные значения в полях Степень похожести (%) и Максимальная длина термина для поиска
    • нажмите на кнопку ОК

    Будет выполнен автоматический поиск и анализ терминов в документе, в соответствии с выбранными классами терминологической базы.

  4. В окне Поиск терминов в документе отберите необходимые термины для включения в документ и нажмите на кнопку Применить

Будет выполнена автоматическая разметка документа терминами.

  1. Для просмотра информации о термине или элементах дискурса, кликните по соответствующему термину в виджете Редактор

  2. Для просмотра определений терминов, кликните по соответствующему термину в виджете Предварительный просмотр

Внимание

Разметка терминами является необратимым действием, поэтому автосохранение документа будет отключено! Если вы не хотите сохранять изменения, обновите страницу без сохранения документа.

  1. При необходимости, выполните повторную разметку документа терминами, используя Параметры разметки терминами
  2. Для сохранения результата разметки, выполните сохранение документа (кнопка Сохранить документ на Панели инструментов Редактора)

Извлечение терминов ​

Извлечение терминов из содержимого структурированного документа выполняется автоматически, с учетом предметной области и контекста документа.

Информация

Функция Извлечение терминов в своей работе использует LLM модель и специализированный промпт. Для выполнения кастомизированной настройки данной функции обратитесь к администратору.

Для всех извлеченных терминов система автоматически формирует определения. Пользователь может отобрать необходимые термины и определить класс, в который извлеченные термины будут сохранены для дальнейшего использования. В дальнейшем, по извлеченным терминам и сформированным определениям, можно автоматически создать глоссарий.

Для извлечения терминов из содержимого документа:

  1. Нажмите на кнопку Извлечь термины на Панели инструментов Редактора

  2. В появившемся окне:

    • в поле Класс для терминов выберите класс для сохранения извлеченных терминов
    • нажмите на кнопку Извлечь термины

    После проведения анализы система выведет информационное сообщение о количестве извлеченных терминов и откроет список извлеченных терминов с определениями.

    • при необходимости, снимите флажки с терминов, которые не нужно сохранять
    • для сохранения терминов нажмите на кнопку Сохранить

    Извлеченные термины будут сохранены в указанном классе как экземпляры, а их определения - в соответствующем дискурсе объекта (дискурс объекта типа "Определение")

    Совет

    При необходимости, вы всегда сможете отредактировать извлеченные термины и их определения, открыв онтологию, содержащую класс с извлеченными терминами или сконфигурировав соответствующее Рабочее пространство.

    Как автоматически создать глоссарий из извлеченных терминов, описано в разделе Глоссарий.

Поиск и замена ​

Для поиска и замены текста в Редакторе используется функция Поиск и замена. Данная функция применяется только к компонентам с текстовым содержимым. Поддерживается многострочный ввод.

Для поиска и замены текста в редакторе:

  1. Используйте горячие клавиши Ctrl + F для открытия диалогового окна
  2. Введите текст:
    • в поле Текст для поиска введите слово или фразу, которую хотите найти
    • раскройте область замены с помощью кнопки "Показать замену" и в поле Заменить на введите текст, на который хотите заменить найденное слово или фразу
  3. Выберите действие:
    • для перехода по найденным результатам используйте кнопки "Следующее совпадение" и "Предыдущее совпадение"
    • для замены текущего найденного вхождения и перехода к следующему, нажмите на кнопку "Заменить"
    • для замены всех найденных вхождений слова или фразы в документе, нажмите на кнопку "Заменить все"